[beta] Get engine immobilizer states

Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won’t be any state returned for that vehicle.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Vehicle Immobilization under the Vehicles category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /fleet/vehicles/immobilizer/stream

[beta] Get engine immobilizer states

cURL

curl --request GET \
  --url https://api.samsara.com/fleet/vehicles/immobilizer/stream \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "happenedAtTime": "2019-06-13T19:08:25Z",
      "isConnectedToVehicle": false,
      "relayStates": [
        {
          "id": "relay1",
          "isOpen": true
        }
      ],
      "vehicleId": "1234"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

vehicleIds · string · required

A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186

startTime · string · required

A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endTime · string

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

200

application/json

OK response.

data · object[] · required

A list of engine immobilizer states in ascending order of happenedAtTime.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes